home *** CD-ROM | disk | FTP | other *** search
/ Aminet 25 / Aminet 25 (1998)(GTI - Schatztruhe)[!][Jun 1998].iso / Aminet / text / misc / nroff.lha / nroff / tests.shar.Z / tests.shar / ex1.out < prev    next >
Text File  |  1998-03-09  |  3KB  |  133 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                           NROFF Report Formatting
  8.                                      
  9.                                     by
  10.                                      
  11.                               Bill Rosenkranz
  12.                             rosenkra@convex.com
  13.  
  14.  
  15.           Nroff  is a text processor and formatter based on the design
  16.      provided in "Software Tools" by Kernighan and Plauger.    It  has
  17.      been  modified  to  closely  resemble the Unix(tm) nroff command.
  18.      The text and commands found  in  the  file(s)  are  processed  to
  19.      generate formatted  text.    Note  that one (and only one) of the
  20.      files can be "-" which reads input from stdin at that point.  The 
  21.      output always goes to stdout  which  can  be  redirected  by  the
  22.      shell.   The  -o  option  lets  you  redirect error output to the
  23.      specified file rather than stderr.  Debugging information  always
  24.      goes  to  the  file  "nroff.dbg"  and  is generally used only for
  25.      program development.  
  26.  
  27.  
  28.           Nroff recognizes the following  environment  variables  from
  29.      the shell.  
  30.  
  31.  
  32.           An  alternate  directory  to  find the files tmac.* ("." for
  33.      example).  The default is c:\lib\tmac under TOS and /usr/lib/tmac 
  34.      under Minix or Unix(tm).  
  35.  
  36.  
  37.           An alternate directory to place any temporary  files.    The
  38.      default is the current directory.  
  39.  
  40.  
  41.           Commands  typically  are distinguished by a period in column
  42.      one of the input followed by a two character abbreviation for the 
  43.      command funtion.  The abbreviation may then  be  followed  by  an
  44.      optional numeric or character argument.  The numeric argument may 
  45.      be  an  absolute  value  such  as  setting  the right margin to a
  46.      particular column, or the argument may  be  preceded  by  a  plus
  47.      sign  or  a  minus  sign to indicate that the parameter should be
  48.      modified relative to a previous setting.  The following  commands
  49.      are  recognized  (those  marked "extension" are requests added to
  50.      the basic set provided by Unix(tm) nroff): 
  51.  
  52.  
  53.           Begin line adjustment.  If fill mode is not  on,  adjustment
  54.      is defered  until it is back on.  If a type indicator is present,
  55.      the adjustment type is changed as follows:  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.                                    - 1 -
  65.  
  66.  
  67.  
  68.  
  69.                           NROFF Report Formatting
  70.  
  71.  
  72.  
  73.      
  74.      Indicator      Type
  75.         l           adjust left margin only
  76.         r           adjust right margin only
  77.         c           center
  78.      b or n         adjust both margins (default)
  79.      absent         unchanged
  80.  
  81.  
  82.           Causes the following lines of text to  appear  in  boldface.
  83.      The  optional  argument specifies the number of lines to be typed
  84.      in boldface.  Boldface and  underlining  are  mutually  exclusive
  85.      features.   The  appearance  of a boldface command will cause any
  86.      underlining to cease.  
  87.  
  88.  
  89.           Causes succeeding text to appear at the top of a  new  page.
  90.      The  optional  argument  specifies  the  page  number for the new
  91.      page.  The initial value is one and the default value is one more 
  92.      than the previous page number.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.                                    - 2 -
  131.  
  132.  
  133.